home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIControllerCommand.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.4 KB  |  84 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is mozilla.org code.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications Corporation.
  20.  * Portions created by the Initial Developer are Copyright (C) 1998
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40. #include "nsICommandParams.idl"
  41.  
  42. /**
  43.  * nsIControllerCommand
  44.  *
  45.  * A generic command interface. You can register an nsIControllerCommand
  46.  * with the nsIControllerCommandTable.
  47.  */
  48.  
  49. [scriptable, uuid(0eae9a46-1dd2-11b2-aca0-9176f05fe9db)]
  50. interface nsIControllerCommand : nsISupports
  51. {
  52.  
  53.   /**
  54.    * Returns true if the command is currently enabled. An nsIControllerCommand
  55.    * can implement more than one commands; say, a group of related commands
  56.    * (e.g. delete left/delete right). Because of this, the command name is
  57.    * passed to each method.
  58.    *
  59.    * @param aCommandName  the name of the command for which we want the enabled
  60.    *                      state.
  61.    * @param aCommandContext    a cookie held by the nsIControllerCommandTable,
  62.    *                  allowing the command to get some context information.
  63.    *                  The contents of this cookie are implementation-defined.
  64.    */
  65.   boolean isCommandEnabled(in string aCommandName, in nsISupports aCommandContext);
  66.  
  67.   void getCommandStateParams(in string aCommandName, in nsICommandParams aParams, in nsISupports aCommandContext);
  68.   
  69.   /**
  70.    * Execute the name command.
  71.    *
  72.    * @param aCommandName  the name of the command to execute.
  73.    * 
  74.    * @param aCommandContext    a cookie held by the nsIControllerCommandTable,
  75.    *                  allowing the command to get some context information.
  76.    *                  The contents of this cookie are implementation-defined.
  77.    */
  78.   void    doCommand(in string aCommandName, in nsISupports aCommandContext);
  79.  
  80.   void    doCommandParams(in string aCommandName, in nsICommandParams aParams, in nsISupports aCommandContext);
  81.   
  82. };
  83.  
  84.